Get All OC Leads
The Get All OC Leads request retrieves all Operator Connect leads for a specific Service Provider operator tenant. By default, up to 10 pages of results are retrieved. You can narrow this page range according to site testing requirements.
Synchronization and Civic Address Management
| ● | For direct leads (IsDirectLead = true) without civic addresses, the request automatically attempts to synchronize civic address data from Microsoft Operator Connect |
| ● | Civic address sync failures are logged, however do not fail the entire request |
| ● | Successfully synchronized addresses are included in the |
| ● | Online synchronization (Request parameter checkOnline=true) requires a valid msTenantId and may take up to 60 seconds. |
| ● | Civic address synchronization may result in additional processing time. |
| ● | All synchronization operations include timeout protection and error handling. |
When no local records are found and checkOnline is enabled, the endpoint attempts to synchronize lead data from Microsoft's Operator Connect service.
URL
{{baseUrl}}/api/v2/oc/lead?PageSize=200HTTP Method
GET
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
Filters |
|||
|
msTenantId |
´ |
string |
The Microsoft Azure subscription Tenant Id of the customer whose leads you which to retrieve. |
|
checkOnline |
´ |
boolean default: false |
When no local records are found and checkOnline is enabled, the request attempts to synchronize lead data from Microsoft's Operator Connect service. |
|
Pagination |
|||
|
Page Number |
´ |
integer Default value: 1 |
The page number in range to retrieve. |
|
Page Size |
´ |
integer |
The number of pages in range to retrieve. Default value: 10 records per page Support for a maximum of 20,000 records per page. |
Example Response
[
[
{
"civicAddresses": null,
"comments": null,
"umpCustomerGuid": null,
"isNotActive": null,
"channelId": null,
"ovocChannelId": null,
"isDirectLead": false,
"id": "f825e66a-0e07-4d58-9fb3-271f092ceadc",
"tenantId": "f889d778-d028-49e0-8056-b5d24abb7ca7",
"tenantOrigin": null,
"operatorId": "7a4e58a1-8348-4fa5-8d36-4e19125e4ac3",
"status": "Removed",
"consentedOn": "2021-12-21T13:50:02.7271943Z",
"lastModifiedOn": "2022-02-23T11:56:01.5948813Z",
"consentedCountries": [
"IL"
],
"contactDetails": {
"fullName": "Golan",
"email": "golann@audiocodes.com",
"phoneNumber": "4255550100",
"companyName": "qa-int-GolanCDX&-!",
"companySize": "L250_U999"
},
"contacts": [
{
"fullName": "Golan",
"email": "golann@audiocodes.com",
"phoneNumber": "4255550100",
"companyName": "qa-int-GolanCDX&-!",
"companySize": "L250_U999"
}
]
},
{
"civicAddresses": [
{
"id": "7c92121a-9742-49ac-b34b-4855dc65f538",
"country": "IL",
"houseNumber": "4",
"houseNumberSuffix": "",
"preDirectional": "",
"streetName": "mapo",
"streetSuffix": "",
"postDirectional": "",
"stateOrProvince": "",
"countyOrDistrict": "",
"cityOrTown": "Tel aviv",
"cityOrTownAlias": "",
"postalOrZipCode": "6357704",
"description": "Emergency1",
"companyName": "ShilpaOC444062xxxxx1",
"companyId": "",
"defaultLocationId": "9a80b701-1e12-4b1c-ac62-7d056af72cdd",
"validationStatus": "Validated",
"tenantId": "a1a1f1aa-e7c1-4ffc-81e3-7b98e119324a",
"partnerId": "00000000-0000-0000-0000-000000000000",
"locations": [
{
"id": "9a80b701-1e12-4b1c-ac62-7d056af72cdd",
"civicAddressId": "7c92121a-9742-49ac-b34b-4855dc65f538",
"description": "Emergency1",
"additionalInfo": null,
"isDefault": "true",
"elin": null
}
]
}
],
"comments": [],
"umpCustomerGuid": null,
"isNotActive": true,
"channelId": null,
"ovocChannelId": null,
"isDirectLead": false,
"id": "9cfca362-453f-4005-b263-33e2b4b5e459",
"tenantId": "a1a1f1aa-e7c1-4ffc-81e3-7b98e119324a",
"tenantOrigin": null,
"operatorId": "7a4e58a1-8348-4fa5-8d36-4e19125e4ac3",
"status": "Active",
"consentedOn": "2022-01-09T15:21:22.5762667Z",
"lastModifiedOn": "2022-01-10T07:57:55.0623609Z",
"consentedCountries": [
"AF",
"IL",
"NL"
],
"contactDetails": {
"fullName": "e",
"email": "e@e.com",
"phoneNumber": "4255550545",
"companyName": "ShilpaOC444062xxxxx1",
"companySize": "L50_U249"
},
"contacts": [
{
"fullName": "e",
"email": "e@e.com",
"phoneNumber": "4255550545",
"companyName": "ShilpaOC444062xxxxx1",
"companySize": "L50_U249"
}
]
},
{
"civicAddresses": null,
"comments": null,
"umpCustomerGuid": null,
"isNotActive": null,
"channelId": null,
"ovocChannelId": null,
"isDirectLead": false,
"id": "0b587e64-648f-489e-a264-9da7d19bc68a",
"tenantId": "844fcd55-41f9-4ab5-ad68-e95dbf882c21",
"tenantOrigin": null,
"operatorId": "7a4e58a1-8348-4fa5-8d36-4e19125e4ac3",
"status": "Removed",
"consentedOn": "2022-01-09T15:36:51.2106935Z",
"lastModifiedOn": "2022-01-12T13:55:50.5612045Z",
"consentedCountries": [
"AU",
"AX",
"DZ",
"US"
],
"contactDetails": {
"fullName": "f",
"email": "f@f.com",
"phoneNumber": "987987987",
"companyName": "ShilpaOC444062xxxxx2",
"companySize": "L1000_U2999"
},
"contacts": [
{
"fullName": "f",
"email": "f@f.com",
"phoneNumber": "987987987",
"companyName": "ShilpaOC444062xxxxx2",
"companySize": "L1000_U2999"
}
]
},
{
"civicAddresses": [
{
"id": "6c0b743b-5d88-4fbc-8919-f43835c8efe7",
"country": "IL",
"houseNumber": "10",
"houseNumberSuffix": "",
"preDirectional": "",
"streetName": "Shitrit Street",
"streetSuffix": "",
"postDirectional": "",
"stateOrProvince": "Haifa District",
"countyOrDistrict": "",
"cityOrTown": "Haifa",
"cityOrTownAlias": "",
"postalOrZipCode": "26",
"description": "Haifa",
"companyName": "AudioCodes - SQA Live 3",
"companyId": "",
"defaultLocationId": "285ab458-4ef8-477b-ad40-52e19a7cdcc3",
"validationStatus": "Validated",
"tenantId": "daf09efd-f31e-41e4-a86c-bd65bf821e25",
"partnerId": "00000000-0000-0000-0000-000000000000",
"locations": [
{
"id": "285ab458-4ef8-477b-ad40-52e19a7cdcc3",
"civicAddressId": "6c0b743b-5d88-4fbc-8919-f43835c8efe7",
"description": "Haifa",
"additionalInfo": null,
"isDefault": "true",
"elin": null
}
]
},
{
"id": "7071cc80-ed77-11ec-88b5-6dc0c381f96c",
"country": "IL",
"houseNumber": "20",
"houseNumberSuffix": "",
"preDirectional": "",
"streetName": "Habarzel Street",
"streetSuffix": "",
"postDirectional": "",
"stateOrProvince": "Southern District",
"countyOrDistrict": "IL",
"cityOrTown": "Beer Sheva",
"cityOrTownAlias": "",
"postalOrZipCode": "84",
"description": "IL-Emergency",
"companyName": "AudioCodes - SQA Live 3",
"companyId": "",
"defaultLocationId": "bdda8505-3c04-4767-9953-a4e384fa6279",
"validationStatus": "Validated",
"tenantId": "daf09efd-f31e-41e4-a86c-bd65bf821e25",
"partnerId": "00000000-0000-0000-0000-000000000000",
"locations": [
{
"id": "bdda8505-3c04-4767-9953-a4e384fa6279",
"civicAddressId": "7071cc80-ed77-11ec-88b5-6dc0c381f96c",
"description": "IL-Emergency",
"additionalInfo": null,
"isDefault": "true",
"elin": null
}
]
}
],
"comments": [],
"umpCustomerGuid": "c39a9d97-3374-4bab-8648-459795360c7e",
"isNotActive": null,
"channelId": null,
"ovocChannelId": 0,
"isDirectLead": false,
"id": "479de1fc-0310-4c35-bf5f-742baa5c67bd",
"tenantId": "daf09efd-f31e-41e4-a86c-bd65bf821e25",
"tenantOrigin": null,
"operatorId": "7a4e58a1-8348-4fa5-8d36-4e19125e4ac3",
"status": "Active",
"consentedOn": "2022-11-17T09:08:08.0674744Z",
"lastModifiedOn": "2024-01-14T13:24:00.9152229Z",
"consentedCountries": [
"IL",
"AU"
],
"contactDetails": {
"fullName": "golan",
"email": "QA@ai0logics.onmicrosoft.com",
"phoneNumber": "+972333344",
"companyName": "ai0logics",
"companySize": "L25_U49"
},
"contacts": [
{
"fullName": "golan",
"email": "QA@ai0logics.onmicrosoft.com",
"phoneNumber": "+972333344",
"companyName": "ai0logics",
"companySize": "L25_U49"
}
]
},
{
"civicAddresses": null,
"comments": null,
"umpCustomerGuid": null,
"isNotActive": null,
"channelId": null,
"ovocChannelId": null,
"isDirectLead": false,
"id": "93099f3f-506d-4630-a691-c28fc8ee2422",
"tenantId": "e2b78fc7-7081-4d8b-a0ee-86b597bf0502",
"tenantOrigin": null,
"operatorId": "7a4e58a1-8348-4fa5-8d36-4e19125e4ac3",
"status": "Removed",
"consentedOn": "2022-02-14T11:09:18.8860092Z",
"lastModifiedOn": "2022-02-14T11:37:55.2131077Z",
"consentedCountries": [
"US",
"AU"
],
"contactDetails": {
"fullName": "Harsha",
"email": "harsha.govindappa@audiocodes.com",
"phoneNumber": "4255550109",
"companyName": "ShilpaOC444062",
"companySize": "L2_U4"
},
"contacts": [
{
"fullName": "Harsha",
"email": "harsha.govindappa@audiocodes.com",
"phoneNumber": "4255550109",
"companyName": "ShilpaOC444062",
"companySize": "L2_U4"
}
]
},
{
"civicAddresses": null,
"comments": null,
"umpCustomerGuid": null,
"isNotActive": null,
"channelId": null,
"ovocChannelId": null,
"isDirectLead": false,
"id": "cb720317-bd9f-4c91-be28-eed5c2fdf195",
"tenantId": "d618acb7-4650-43da-aab5-dfd629091258",
"tenantOrigin": null,
"operatorId": "7a4e58a1-8348-4fa5-8d36-4e19125e4ac3",
"status": "Removed",
"consentedOn": "2022-01-12T17:21:07.862224Z",
"lastModifiedOn": "2022-01-12T17:49:14.9302234Z",
"consentedCountries": [
"US"
],
"contactDetails": {
"fullName": "roy",
"email": "roy@demo.com",
"phoneNumber": "4255550100",
"companyName": "Contoso Corp Radu",
"companySize": "L3000_UInfinity"
},
"contacts": [
{
"fullName": "roy",
"email": "roy@demo.com",
"phoneNumber": "4255550100",
"companyName": "Contoso Corp Radu",
"companySize": "L3000_UInfinity"
}
]
},
{
"civicAddresses": [
{
"id": "e5a355e0-84fa-11ec-a513-f9ead4fe1981",
"country": "IL",
"houseNumber": "1",
"houseNumberSuffix": "",
"preDirectional": "",
"streetName": "Hayarden Street",
"streetSuffix": "Hayarden Street",
"postDirectional": "",
"stateOrProvince": "Tel Aviv District",
"countyOrDistrict": "IL",
"cityOrTown": "Or Yehuda",
"cityOrTownAlias": "",
"postalOrZipCode": "60",
"description": "AudioCodes",
"companyName": "Trunkpack-es-cust",
"companyId": "",
"defaultLocationId": "9cf915fb-dfd8-4069-a58c-7f3c472d5134",
"validationStatus": "Validated",
"tenantId": "a844ad24-9534-4dc0-b0cd-4b2d0ebe543e",
"partnerId": "00000000-0000-0000-0000-000000000000",
"locations": [
{
"id": "9cf915fb-dfd8-4069-a58c-7f3c472d5134",
"civicAddressId": "e5a355e0-84fa-11ec-a513-f9ead4fe1981",
"description": "AudioCodes",
"additionalInfo": null,
"isDefault": "true",
"elin": null
}
]
}
],
"comments": null,
"umpCustomerGuid": null,
"isNotActive": null,
"channelId": null,
"ovocChannelId": null,
"isDirectLead": false,
"id": "1d880d99-d913-4e80-8203-358b2faf40bf",
"tenantId": "a844ad24-9534-4dc0-b0cd-4b2d0ebe543e",
"tenantOrigin": null,
"operatorId": "7a4e58a1-8348-4fa5-8d36-4e19125e4ac3",
"status": "Active",
"consentedOn": "2022-10-11T06:35:50.4337749Z",
"lastModifiedOn": "2022-10-11T06:35:50.4337749Z",
"consentedCountries": [
"IL",
"RO"
],
"contactDetails": {
"fullName": "golann",
"email": "golann@audiocodes.com",
"phoneNumber": "+972528545755",
"companyName": "Trnkpck-es-cust!@#$%^&*()_+TestLongName",
"companySize": "L250_U999"
},
"contacts": [
{
"fullName": "golann",
"email": "golann@audiocodes.com",
"phoneNumber": "+972528545755",
"companyName": "Trnkpck-es-cust!@#$%^&*()_+TestLongName",
"companySize": "L250_U999"
}
]
},
{
"civicAddresses": [
{
"id": "82bbdb8c-1409-432e-9d4a-e4fed2f89cfa",
"country": "IL",
"houseNumber": "1",
"houseNumberSuffix": "",
"preDirectional": "",
"streetName": "Yarden",
"streetSuffix": "",
"postDirectional": "",
"stateOrProvince": "",
"countyOrDistrict": "",
"cityOrTown": "Lod",
"cityOrTownAlias": "",
"postalOrZipCode": "70000",
"description": "AudioCodes",
"companyName": "AudioCodes",
"companyId": "",
"defaultLocationId": "a99d8c45-88b4-4128-bd5a-1aeff263bcec",
"validationStatus": "Validated",
"tenantId": "d1382f6b-4846-45d7-9ac8-0349c1ed5ead",
"partnerId": "00000000-0000-0000-0000-000000000000",
"locations": [
{
"id": "a99d8c45-88b4-4128-bd5a-1aeff263bcec",
"civicAddressId": "82bbdb8c-1409-432e-9d4a-e4fed2f89cfa",
"description": "AudioCodes",
"additionalInfo": null,
"isDefault": "true",
"elin": null
}
]
},
{
"id": "05e4c57a-42a4-40e6-87e6-ccc56e88a38d",
"country": "US",
"houseNumber": "700",
"houseNumberSuffix": "",
"preDirectional": "",
"streetName": "Rocky Road",
"streetSuffix": "",
"postDirectional": "",
"stateOrProvince": "AR",
"countyOrDistrict": "",
"cityOrTown": "Departee",
"cityOrTownAlias": "",
"postalOrZipCode": "72020",
"description": "check",
"companyName": "AudioCodes US M365",
"companyId": "",
"defaultLocationId": "78bade1e-0a67-4cae-b117-68107e799fec",
"validationStatus": "Validated",
"tenantId": "d1382f6b-4846-45d7-9ac8-0349c1ed5ead",
"partnerId": "00000000-0000-0000-0000-000000000000",
"locations": [
{
"id": "78bade1e-0a67-4cae-b117-68107e799fec",
"civicAddressId": "05e4c57a-42a4-40e6-87e6-ccc56e88a38d",
"description": "check",
"additionalInfo": null,
"isDefault": "true",
"elin": null
}
]
},
{
"id": "7267bf00-b0fb-4c14-b0d0-2c77356d4368",
"country": "US",
"houseNumber": "700",
"houseNumberSuffix": "",
"preDirectional": "",
"streetName": "Rocky Road",
"streetSuffix": "",
"postDirectional": "",
"stateOrProvince": "OH",
"countyOrDistrict": "",
"cityOrTown": "Springfield",
"cityOrTownAlias": "",
"postalOrZipCode": "45601",
"description": "US",
"companyName": "AudioCodes US M365",
"companyId": "",
"defaultLocationId": "20a9c9c7-210c-4292-9089-08734d63c4b5",
"validationStatus": "Validated",
"tenantId": "d1382f6b-4846-45d7-9ac8-0349c1ed5ead",
"partnerId": "00000000-0000-0000-0000-000000000000",
"locations": [
{
"id": "20a9c9c7-210c-4292-9089-08734d63c4b5",
"civicAddressId": "7267bf00-b0fb-4c14-b0d0-2c77356d4368",
"description": "US",
"additionalInfo": null,
"isDefault": "true",
"elin": null
}
]
},
{
"id": "0f61c29c-1cbe-48c8-8def-2254d6071590",
"country": "NL",
"houseNumber": "3D",
"houseNumberSuffix": "",
"preDirectional": "",
"streetName": "Versterkerstraat",
"streetSuffix": "",
"postDirectional": "",
"stateOrProvince": "Flevoland",
"countyOrDistrict": "",
"cityOrTown": "Almere",
"cityOrTownAlias": "",
"postalOrZipCode": "1322",
"description": "NL Almere",
"companyName": "AudioCodes NL M365",
"companyId": "12345",
"defaultLocationId": "e8a1e579-25c4-4f3f-b55c-08b239e58fb8",
"validationStatus": "Validated",
"tenantId": "d1382f6b-4846-45d7-9ac8-0349c1ed5ead",
"partnerId": "00000000-0000-0000-0000-000000000000",
"locations": [
{
"id": "e8a1e579-25c4-4f3f-b55c-08b239e58fb8",
"civicAddressId": "0f61c29c-1cbe-48c8-8def-2254d6071590",
"description": "NL Almere",
"additionalInfo": null,
"isDefault": "true",
"elin": null
},
{
"id": "7de4cf27-da48-44df-be24-0f666220e8f1",
"civicAddressId": "0f61c29c-1cbe-48c8-8def-2254d6071590",
"description": "NL Almere",
"additionalInfo": "1st floor",
"isDefault": "false",
"elin": null
}
]
}
],
"comments": [],
"umpCustomerGuid": "bb9fac5f-6b72-4e33-8bd6-8e6ef8342bc3",
"isNotActive": null,
"channelId": null,
"ovocChannelId": 907,
"isDirectLead": false,
"id": "691aa0bb-5396-4df6-97ad-83f82e4a64e2",
"tenantId": "d1382f6b-4846-45d7-9ac8-0349c1ed5ead",
"tenantOrigin": null,
"operatorId": "7a4e58a1-8348-4fa5-8d36-4e19125e4ac3",
"status": "Active",
"consentedOn": "2023-03-19T12:14:44.9624543Z",
"lastModifiedOn": "2023-03-19T12:14:44.9624543Z",
"consentedCountries": [
"IL"
],
"contactDetails": {
"fullName": "roydemo3",
"email": "roydemo3@audiocodes.com",
"phoneNumber": "+4255550100",
"companyName": "AudioCodes US M365",
"companySize": "L2_U4"
},
"contacts": [
{
"fullName": "roydemo3",
"email": "roydemo3@audiocodes.com",
"phoneNumber": "+4255550100",
"companyName": "AudioCodes US M365",
"companySize": "L2_U4"
}
]
},
{
"civicAddresses": [],
"comments": [],
"umpCustomerGuid": "11d7c50f-414e-48f9-91c1-8e4deec94054",
"isNotActive": null,
"channelId": null,
"ovocChannelId": 0,
"isDirectLead": false,
"id": "e18efef1-4251-46eb-a6b1-f533fae3c963",
"tenantId": "2aa6292d-f096-4445-a0b3-ae6783d1b47b",
"tenantOrigin": null,
"operatorId": "7a4e58a1-8348-4fa5-8d36-4e19125e4ac3",
"status": "Active",
"consentedOn": "2022-05-10T11:08:23.8541687Z",
"lastModifiedOn": "2022-05-10T11:08:23.8541687Z",
"consentedCountries": [
"IL"
],
"contactDetails": {
"fullName": "golan",
"email": "fmgjgj@fjfhjf.com",
"phoneNumber": "+97239764246",
"companyName": "audio00code",
"companySize": "L50_U249"
},
"contacts": [
{
"fullName": "golan",
"email": "fmgjgj@fjfhjf.com",
"phoneNumber": "+97239764246",
"companyName": "audio00code",
"companySize": "L50_U249"
}
]
},
{
"civicAddresses": [
{
"id": "9a922a6b-0a6c-4348-a849-71bf544560e0",
"country": "IL",
"houseNumber": "1",
"houseNumberSuffix": "",
"preDirectional": "",
"streetName": "Hayarden Street",
"streetSuffix": "",
"postDirectional": "",
"stateOrProvince": "Central District",
"countyOrDistrict": "",
"cityOrTown": "Ramle",
"cityOrTownAlias": "",
"postalOrZipCode": "72",
"description": "audc-at",
"companyName": "audc-at",
"companyId": "",
"defaultLocationId": "3985cac3-ec25-491d-b4b4-f5f1c04a13eb",
"validationStatus": "Validated",
"tenantId": "21c213d9-baf1-43af-9822-712e86b9265e",
"partnerId": "00000000-0000-0000-0000-000000000000",
"locations": [
{
"id": "3985cac3-ec25-491d-b4b4-f5f1c04a13eb",
"civicAddressId": "9a922a6b-0a6c-4348-a849-71bf544560e0",
"description": "audc-at",
"additionalInfo": null,
"isDefault": "true",
"elin": null
}
]
}
],
"comments": null,
"umpCustomerGuid": null,
"isNotActive": null,
"channelId": null,
"ovocChannelId": null,
"isDirectLead": false,
"id": "8acfb14f-231e-4fff-b9dc-f3128f503279",
"tenantId": "21c213d9-baf1-43af-9822-712e86b9265e",
"tenantOrigin": null,
"operatorId": "7a4e58a1-8348-4fa5-8d36-4e19125e4ac3",
"status": "Active",
"consentedOn": "2022-08-03T07:30:21.2473927Z",
"lastModifiedOn": "2023-11-07T08:05:08.9239371Z",
"consentedCountries": [
"BG",
"CA",
"IL"
],
"contactDetails": {
"fullName": "rivka_1",
"email": "yarivv@audio-codes.at",
"phoneNumber": "+1231564897",
"companyName": "audio-codes-at",
"companySize": "L1000_U2999"
},
"contacts": [
{
"fullName": "rivka_1",
"email": "yarivv@audio-codes.at",
"phoneNumber": "+1231564897",
"companyName": "audio-codes-at",
"companySize": "L1000_U2999"
}
]
}
]| ■ | 200 OK |
|
Parameters |
Type |
Description |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
civicAddresses |
dictionary |
List array including the following values:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
comments |
list array |
Comments added by the operator regarding the lead. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
umpCustomerGuid |
string($uuid) |
Id that is created on the Live Platform database for the customer tenant when a Live Platform license is applied. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
isNotActive |
boolean |
Indicates whether an Operator Connect license has been applied to the lead. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ovocChannelId |
string |
The Microsoft Tenant Id of the channel to which the lead is attached. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
isDirectLead |
boolean |
Indicates whether the lead was created as a Consentless lead. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
id |
string |
Internal Id generated by Live Platform; used for debugging purposes. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
tenantId |
string |
The Microsoft Azure subscription Tenant Id of the customer lead. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
tenantOrigin |
string |
Office365 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
operatorId |
string |
Id of the operator performing Onboarding with Global Admin or Service account permissions. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
status |
string |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
consentedOn |
string ($date-time) |
The date of consent by the operator. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
lastModifiedOn |
string ($date-time) |
The last date of modification by the operator. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
consentedCountries |
list array |
The countries for which the customer consented to activate user calling (as configured in their Teams admin center). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
contactDetails |
dictionary |
List array of personal contact details of the customer lead:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
contacts |
dictionary |
List array for Contact details of the service lead:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
fullName |
string |
Full name of the customer Global administrator contact or Service account contact. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
string |
Email of the customer Global administrator contact or Service account contact. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
phoneNumber |
string |
Phone number of the customer Global administrator contact or Service account contact. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
companySize |
string |
The number of employees of the customer lead. |
| ■ | 400 Bad Request |
|
Parameter |
Type |
Description/Examples |
|---|---|---|
|
errors |
string |
Text description of the error. |
|
type |
string |
"https://tools.ietf.org/html/rfc7231#section-6.5.1" |
|
title |
string |
Email title. For example "One or more validation errors occurred." |
|
status |
error code |
HTML error code i.e. 400 |
|
detail |
string |
Additional error details. |
|
traceId |
string |
Error trace Id |
|
instance |
string |
Error instance |
|
errorTicket |
string |
This field may not appear for all return codes. |
|
errorCode |
string |
This field may not appear for all return codes. |
|
additionalProp1 |
string |
Custom Script variable argument. For example "CacProfile": "5 sessions" |
|
additionalProp2 |
string |
Custom Script argument. For example, ProxySet": "SIPTrunk" |
|
additionalProp3 |
string |
Custom Script argument. For example, "OnlinePstnGateway": "sandbox1.audiocodes.be" |
| ■ | 404 Not Found |
|
Parameter |
Type |
Description/Examples |
|---|---|---|
|
errors |
string |
Text description of the error. |
|
type |
string |
"https://tools.ietf.org/html/rfc7231#section-6.5.1" |
|
title |
string |
Email title. For example "One or more validation errors occurred." |
|
status |
error code |
HTML error code i.e. 400 |
|
detail |
string |
Additional error details. |
|
traceId |
string |
Error trace Id |
|
instance |
string |
Error instance |
|
errorTicket |
string |
This field may not appear for all return codes. |
|
errorCode |
string |
This field may not appear for all return codes. |
|
additionalProp1 |
string |
Custom Script variable argument. For example "CacProfile": "5 sessions" |
|
additionalProp2 |
string |
Custom Script argument. For example, ProxySet": "SIPTrunk" |
|
additionalProp3 |
string |
Custom Script argument. For example, "OnlinePstnGateway": "sandbox1.audiocodes.be" |
| ■ | 500 Internal Server Error |
|
Parameter |
Type |
Description/Examples |
|---|---|---|
|
errors |
string |
Text description of the error. |
|
type |
string |
"https://tools.ietf.org/html/rfc7231#section-6.5.1" |
|
title |
string |
Email title. For example "One or more validation errors occurred." |
|
status |
error code |
HTML error code i.e. 400 |
|
detail |
string |
Additional error details. |
|
traceId |
string |
Error trace Id |
|
instance |
string |
Error instance |
|
errorTicket |
string |
This field may not appear for all return codes. |
|
errorCode |
string |
This field may not appear for all return codes. |
|
additionalProp1 |
string |
Custom Script variable argument. For example "CacProfile": "5 sessions" |
|
additionalProp2 |
string |
Custom Script argument. For example, ProxySet": "SIPTrunk" |
|
additionalProp3 |
string |
Custom Script argument. For example, "OnlinePstnGateway": "sandbox1.audiocodes.be" |